feat: Add static file serving support in webconsole #191

patriciareinoso · 2024-06-20T12:11:48Z

Description

This PR adds support for serving static files. Now it is possible to have a UI in front of webui.
This feature is enabled using go build tags. Default behavior is not changed.

Usage

Webconsole can optionally serve static files, which constitute the frontend part of the application.

To build webui with a frontend, place the static files under webconsole/ui/frontend_files before compilation.

To build the webconsole including the UI option:

make webconsole-ui

Access the UI at:

http://<webconsole-ip>:5000/

The webconsole/ui/frontend_files directory contains an example of a basic static html file that looks like this:

Rationale

Canonical builds its own UI for WebConsole (we call it NMS), which is currently operated as a standalone service. The goal is for us to be able to build and deploy WebConsole as one service/container, including both the backend and front end.
The NMS static files will be served by the UI service added.

Code explanation

The AddUiService method will be used from either backend/webui_service/dummy_ui_service.go or backend/webui_service/ui_service.go depending on the use of the ui build tag during the Go build process.

backend/webui_service/dummy_ui_service.go

backend/webui_service/ui_service.go

ui/embed.go

gab-arrobo · 2024-06-20T15:31:43Z

@patriciareinoso, to address the issue with the DCO check, you need to sign off your commits. That is, append the -s flag to your commits

README.md

gab-arrobo · 2024-06-20T17:39:00Z

@patriciareinoso, does this PR replace #143?

patriciareinoso · 2024-06-21T06:56:57Z

@patriciareinoso, does this PR replace #143?

yes

gruyaume

Overall this looks good, I got a couple of comments to make the PR make more sense to people not familiar with the change

Makefile

README.md

Signed-off-by: Patricia Reinoso <patricia.reinoso@canonical.com>

Co-authored-by: gab-arrobo <gabriel.arrobo@intel.com> Signed-off-by: Patricia Reinoso <patricia.reinoso@canonical.com>

Co-authored-by: Guillaume Belanger <guillaume.belanger27@gmail.com> Signed-off-by: Patricia Reinoso <patricia.reinoso@canonical.com>

Signed-off-by: Patricia Reinoso <patricia.reinoso@canonical.com>

gatici

Great job. This PR allows to have a UI for Webui (optionally).

thakurajayL · 2024-07-07T02:30:50Z

Overall, I do not have objection in merging. Is it like Canonical copies list of static files before compilation?

"To build webui with a frontend, place the static files under webconsole/ui/frontend_files before compilation."

patriciareinoso · 2024-07-08T13:34:39Z

Overall, I do not have objection in merging. Is it like Canonical copies list of static files before compilation?

"To build webui with a frontend, place the static files under webconsole/ui/frontend_files before compilation."

The solutions is generic so any set of frontend static files would work. At Canonical, we have a frontend implementation but its code is not meant to be added to this repo.
So, in order to have a running webui we manually copy the static files under the specified directory, compile and run the service

patriciareinoso · 2024-07-09T08:51:58Z

@gab-arrobo @thakurajayL can we move forward and merge this?

gab-arrobo · 2024-07-09T13:42:58Z

@gab-arrobo @thakurajayL can we move forward and merge this?

I am still travelling and do not have my laptop with me to take another look at it. As of last time I checked the PR, everything looked good to me.

One thing that I am wondering how it will be handled is about the process to provide support/guidance to users who want to use this capability/feature? @thakurajayL @gruyaume what are your thoughts about this?

gruyaume · 2024-07-10T12:29:58Z

@gab-arrobo @thakurajayL can we move forward and merge this?

I am still travelling and do not have my laptop with me to take another look at it. As of last time I checked the PR, everything looked good to me.

One thing that I am wondering how it will be handled is about the process to provide support/guidance to users who want to use this capability/feature? @thakurajayL @gruyaume what are your thoughts about this?

For people using our distribution of SD-Core with our frontend, we have a "bug" link in the ui that points to our issue tracker. If we find that the bug is with the underlying webui code here, we'll address it.

For users who want to use their own frontend, I encourage to look at how we're doing it. This repo is publicly accessible, and I'm happy with other people using our approach. Patricia also added lines in the README to explain how to use webui with any static web files.

thakurajayL · 2024-07-11T13:29:41Z

Can you confirm if you addressed the comments from Gabriel. so that it can be merged.

patriciareinoso · 2024-07-11T13:32:13Z

Can you confirm if you addressed the comments from Gabriel. so that it can be merged.

yes, all the comments from Gabriel were taken into account

All comments addressed and Gabriel is on PTO. Can not hold changes for long.

gab-arrobo previously requested changes Jun 20, 2024

View reviewed changes

backend/webui_service/dummy_ui_service.go Outdated Show resolved Hide resolved

backend/webui_service/ui_service.go Outdated Show resolved Hide resolved

ui/embed.go Outdated Show resolved Hide resolved

gab-arrobo reviewed Jun 20, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

patriciareinoso force-pushed the serve-frontend-static-files branch 2 times, most recently from b23f2e7 to 24152f4 Compare June 21, 2024 06:56

gruyaume mentioned this pull request Jun 21, 2024

feat: add static files support for ui #143

Closed

gruyaume reviewed Jun 21, 2024

View reviewed changes

Makefile Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

gruyaume suggested changes Jun 21, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

gab-arrobo reviewed Jun 21, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

patriciareinoso and others added 11 commits June 25, 2024 13:04

serve frontend static files

686afc8

Signed-off-by: Patricia Reinoso <patricia.reinoso@canonical.com>

use route / to serve static files

4563519

Signed-off-by: Patricia Reinoso <patricia.reinoso@canonical.com>

reorganize files and packages

1e78753

Signed-off-by: Patricia Reinoso <patricia.reinoso@canonical.com>

fix format

cda41d0

Signed-off-by: Patricia Reinoso <patricia.reinoso@canonical.com>

fix copyright job

b7e1e25

Signed-off-by: Patricia Reinoso <patricia.reinoso@canonical.com>

Update README.md

6e992f3

Co-authored-by: gab-arrobo <gabriel.arrobo@intel.com> Signed-off-by: Patricia Reinoso <patricia.reinoso@canonical.com>

Update README.md

0194f4f

Co-authored-by: Guillaume Belanger <guillaume.belanger27@gmail.com> Signed-off-by: Patricia Reinoso <patricia.reinoso@canonical.com>

Update README.md

f857682

Co-authored-by: Guillaume Belanger <guillaume.belanger27@gmail.com> Signed-off-by: Patricia Reinoso <patricia.reinoso@canonical.com>

add example of ui static files

357082e

Signed-off-by: Patricia Reinoso <patricia.reinoso@canonical.com>

update readme

290e90c

Signed-off-by: Patricia Reinoso <patricia.reinoso@canonical.com>

move example files to frontend_files

1ce30a7

Signed-off-by: Patricia Reinoso <patricia.reinoso@canonical.com>

patriciareinoso force-pushed the serve-frontend-static-files branch from 2139ffb to 1ce30a7 Compare June 25, 2024 11:04

patriciareinoso added 2 commits June 26, 2024 11:01

remove complex frontend files

4bee127

Signed-off-by: Patricia Reinoso <patricia.reinoso@canonical.com>

add license

93f675b

Signed-off-by: Patricia Reinoso <patricia.reinoso@canonical.com>

patriciareinoso requested review from gruyaume and gab-arrobo June 26, 2024 15:03

gruyaume approved these changes Jun 26, 2024

View reviewed changes

gab-arrobo requested a review from thakurajayL June 28, 2024 01:38

patriciareinoso mentioned this pull request Jul 1, 2024

feat: config gNBs and UPFs #194

Merged

patriciareinoso mentioned this pull request Jul 1, 2024

feat: use webui API in NMS canonical/sdcore-nms#619

Merged

6 tasks

gatici approved these changes Jul 3, 2024

View reviewed changes

patriciareinoso mentioned this pull request Jul 4, 2024

feat: add webui backend to rock canonical/sdcore-nms#621

Merged

6 tasks

Merge branch 'master' into serve-frontend-static-files

461a40e

thakurajayL approved these changes Jul 11, 2024

View reviewed changes

thakurajayL merged commit 5ed83b6 into omec-project:master Jul 16, 2024
8 checks passed

patriciareinoso deleted the serve-frontend-static-files branch August 13, 2024 06:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add static file serving support in webconsole #191

feat: Add static file serving support in webconsole #191

patriciareinoso commented Jun 20, 2024 •

edited

Loading

gab-arrobo commented Jun 20, 2024

gab-arrobo commented Jun 20, 2024

patriciareinoso commented Jun 21, 2024

gruyaume left a comment

gatici left a comment

thakurajayL commented Jul 7, 2024

patriciareinoso commented Jul 8, 2024

patriciareinoso commented Jul 9, 2024

gab-arrobo commented Jul 9, 2024

gruyaume commented Jul 10, 2024

thakurajayL commented Jul 11, 2024

patriciareinoso commented Jul 11, 2024

feat: Add static file serving support in webconsole #191

feat: Add static file serving support in webconsole #191

Conversation

patriciareinoso commented Jun 20, 2024 • edited Loading

Description

Usage

Rationale

Code explanation

gab-arrobo commented Jun 20, 2024

gab-arrobo commented Jun 20, 2024

patriciareinoso commented Jun 21, 2024

gruyaume left a comment

Choose a reason for hiding this comment

gatici left a comment

Choose a reason for hiding this comment

thakurajayL commented Jul 7, 2024

patriciareinoso commented Jul 8, 2024

patriciareinoso commented Jul 9, 2024

gab-arrobo commented Jul 9, 2024

gruyaume commented Jul 10, 2024

thakurajayL commented Jul 11, 2024

patriciareinoso commented Jul 11, 2024

patriciareinoso commented Jun 20, 2024 •

edited

Loading